<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>serializer::read (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Chapter 1. Boost.JSON">
<link rel="up" href="../read.html" title="serializer::read">
<link rel="prev" href="../read.html" title="serializer::read">
<link rel="next" href="overload2.html" title="serializer::read (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../read.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="json.ref.boost__json__serializer.read.overload1"></a><a class="link" href="overload1.html" title="serializer::read (1 of 2 overloads)">serializer::read
          (1 of 2 overloads)</a>
</h6></div></div></div>
<p>
            Read the next buffer of serialized JSON.
          </p>
<h7><a name="json.ref.boost__json__serializer.read.overload1.h0"></a>
            <span class="phrase"><a name="json.ref.boost__json__serializer.read.overload1.synopsis"></a></span><a class="link" href="overload1.html#json.ref.boost__json__serializer.read.overload1.synopsis">Synopsis</a>
          </h7><pre class="programlisting"><span class="identifier">string_view</span>
<span class="identifier">read</span><span class="special">(</span>
    <span class="keyword">char</span><span class="special">*</span> <span class="identifier">dest</span><span class="special">,</span>
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span><span class="special">);</span>
</pre>
<h7><a name="json.ref.boost__json__serializer.read.overload1.h1"></a>
            <span class="phrase"><a name="json.ref.boost__json__serializer.read.overload1.description"></a></span><a class="link" href="overload1.html#json.ref.boost__json__serializer.read.overload1.description">Description</a>
          </h7><p>
            This function attempts to fill the caller provided buffer starting at
            <code class="computeroutput"><span class="identifier">dest</span></code> with up to <code class="computeroutput"><span class="identifier">size</span></code> characters of the serialized JSON
            that represents the value. If the buffer is not large enough, multiple
            calls may be required.
          </p>
<p>
            If serialization completes during this call; that is, that all of the
            characters belonging to the serialized value have been written to caller-provided
            buffers, the function <a class="link" href="../done.html" title="serializer::done"><code class="computeroutput"><span class="identifier">done</span></code></a> will return <code class="computeroutput"><span class="keyword">true</span></code>.
          </p>
<h7><a name="json.ref.boost__json__serializer.read.overload1.h2"></a>
            <span class="phrase"><a name="json.ref.boost__json__serializer.read.overload1.preconditions"></a></span><a class="link" href="overload1.html#json.ref.boost__json__serializer.read.overload1.preconditions">Preconditions</a>
          </h7><p>
            <code class="computeroutput"><span class="keyword">this</span><span class="special">-&gt;</span><span class="identifier">done</span><span class="special">()</span> <span class="special">==</span> <span class="keyword">true</span></code>
          </p>
<h7><a name="json.ref.boost__json__serializer.read.overload1.h3"></a>
            <span class="phrase"><a name="json.ref.boost__json__serializer.read.overload1.complexity"></a></span><a class="link" href="overload1.html#json.ref.boost__json__serializer.read.overload1.complexity">Complexity</a>
          </h7><p>
            Linear in <code class="computeroutput"><span class="identifier">size</span></code>.
          </p>
<h7><a name="json.ref.boost__json__serializer.read.overload1.h4"></a>
            <span class="phrase"><a name="json.ref.boost__json__serializer.read.overload1.exception_safety"></a></span><a class="link" href="overload1.html#json.ref.boost__json__serializer.read.overload1.exception_safety">Exception
            Safety</a>
          </h7><p>
            Basic guarantee. Calls to <code class="computeroutput"><span class="identifier">memory_resource</span><span class="special">::</span><span class="identifier">allocate</span></code>
            may throw.
          </p>
<h7><a name="json.ref.boost__json__serializer.read.overload1.h5"></a>
            <span class="phrase"><a name="json.ref.boost__json__serializer.read.overload1.return_value"></a></span><a class="link" href="overload1.html#json.ref.boost__json__serializer.read.overload1.return_value">Return
            Value</a>
          </h7><p>
            A <a class="link" href="../../boost__json__string_view.html" title="string_view"><code class="computeroutput"><span class="identifier">string_view</span></code></a>
            containing the characters written, which may be less than <code class="computeroutput"><span class="identifier">size</span></code>.
          </p>
<h7><a name="json.ref.boost__json__serializer.read.overload1.h6"></a>
            <span class="phrase"><a name="json.ref.boost__json__serializer.read.overload1.parameters"></a></span><a class="link" href="overload1.html#json.ref.boost__json__serializer.read.overload1.parameters">Parameters</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Name
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">dest</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      A pointer to valid memory of at least <code class="computeroutput"><span class="identifier">size</span></code>
                      bytes.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">size</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The maximum number of characters to write to the memory pointed
                      to by <code class="computeroutput"><span class="identifier">dest</span></code>.
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Vinnie Falco<br>Copyright © 2020 Krystian Stasiowski<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../read.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
